           _____________________________________
  ________|                                     |________
  \       |   Super Mario 64: Kirby Edition     |       /
   \      |_____________________________________|      /
   /__________}                              {_________\ v1.1
		   A Mini Hack By Dudaw
      http://dudaw.webs.com/misc/sm64_kirby/index.html


----------------------------------------------------------------
			Description
----------------------------------------------------------------

"Super Mario 64: Kirby Edition" is the first *full* character
hack ever done in Super Mario 64.
The mod is complete with a custom model port, new sound effects,
and some fun extras.
Now it's your turn to play Super Mario 64...Kirby style.

Major Features:
- Play as Kirby anywhere
- New sound effects
- Play as Thwomp (Metal Cap)
- Play as Boo (Vanish Cap)
- Ride the "Warp Star" in some levels

Many textures and dialogues have also been updated so that they
better correlate with Kirby.
Some other minor hacks were done in order to avoid bugs,
although they'll probably go unnoticed during gameplay.


----------------------------------------------------------------
		          Setup
----------------------------------------------------------------

Getting Started
---------------
The mod runs on a decompressed version of the Super Mario 64
ROM (US-NTSC).
Before continuing, make sure you've extended your ROM so that
it is 24 MB (192.0 MBit) in size.

Download the ROM Extender:
http://homepage.mac.com/qubedstudios/Mario64Tools.htm

Linux users:
http://desktop64.homeip.net:8086/newextender-0.02.tar.gz

Patching the hack to your ROM
-----------------------------
1. Download the PPF-O-Matic program:
http://www.romhacking.net/utils/356/

2. Open ppf-o-matic, click the disk icon next to "ISO File" 
and locate your extended ROM.
Set the "Files of type" drop-down to "All Files" to more
easily locate your ROM.

3. Click on the icon next to "Patch" and open the Kirby
PPF patch "sm64_kirby_edition_v1_1.ppf"

4. Click the "Apply" button, and when it gives you a message
to burn the CD, simply close the window.

5. That's it, as far as getting the mod into your ROM goes.
Check the emulator setup below if you have any problems
running the game.

Configuring Your Emulator
-------------------------
Project64 is suggested for playing this hack.
Although the game should work on most emulators, some such 
as Nemu64 can't handle the decompressed ROM.

You should use either of the following graphics plugins when
playing this hack:
- Jabo's Direct3D8 1.6 (not 1.5.2!)
- glN64 v0.4.1
(You can change your graphics plugin by going to "Options > 
Settings > Plugins.")

You may want to avoid using "Rice's Video Plugin 6.1.1 beta 10"
and "Jabo's Direct3D8 1.5.2" as your graphics plugins.


----------------------------------------------------------------
		    Playing the Game
----------------------------------------------------------------

If you've played the original Mario game, then playing this mod
should be pretty much self-explanatory.
Of course, the only major difference between the original game
and this mod is that Kirby is now the playable character.
A few small changes were made just for the sake of
functionality, but they will most likely go unnoticed during
gameplay.

Some minor changes you may notice when playing:
- No Mario head at the title screen
- You won't be able to kick after two punches
- You won't ever "lose your cap"

Again, these hacks were only done so that no bugs would arise.


----------------------------------------------------------------
			Credits
----------------------------------------------------------------

Contributors
------------
Messiaen (Frauber):
Messiaen's level importer was used to 
translate a Kirby model into SM64's Fast3D format.
However, this wasn't all just "import-and-go."
Getting the mod working as a whole was a totally different
story.

VL-Tone:
The commented Mario geo layout document was useful for getting
the model in order, although a lot of revision was necessary.

SubDrag and Ice Mario (Authors of the N64 Sound List Tool):
Big thanks for making sound crossover a lot easier during the
creation of this mod.
Fitting all of the sounds into the game with 100% quality and
then making over a hundred changes was still a time-consuming
process, though.

Resources
---------
The Kirby Model:
Kirby's model was ripped from Super Smash Bros.,
modified in a 3D modeler, and then imported back into SM64.

The Sound Effects:
The sound effects used in this mod were ported directly from
Kirby 64 and Super Smash Bros.
Some of Ness' sounds work very well for Kirby!

Textures:
Most of the textures were taken from the same two games
(Kirby 64 and Super Smash Bros).

Cap Music:
The song used for cap power-ups was the invincible Lollipop
theme from "Kirby Super Star" (SNES).
Extra music wasn't my top priority, so it could have been a
lot better.


----------------------------------------------------------------
			History
----------------------------------------------------------------

v1.0
----
The first prototype of Super Mario 64 Kirby Edition was
completed and previewed on December 20, 2010.
In this version, the Kirby model was only implemented in a
special bank which only existed in the test stage from
the 2010 preview.
This explains why I never just "released" the mod at any
given moment; a ton of work still needed to be done if anyone
wanted a functional release.

v1.1
----
This is the first and possibly final release of the Kirby mod.
Here's what's changed since v1.0:
- Full functionality in other courses beside BoB
- A few revisions to the Kirby model
- New Kirby sound effects
- Play as Boo (Vanish Cap)
- Play as Thwomp (Metal Cap)
- Updated dialogue (changed so that they don't relate to Mario)
- New title screen (replaces 3D Mario head)
- Different cap power-up music
- Updated textures (changed so that they don't relate to Mario)
- Other minor hacks to make everything functional and pretty


----------------------------------------------------------------

"Super Mario 64" is copyright of Nintendo.
I do not claim any ownership of the game "Super Mario 64," nor
is "Super Mario 64: Kirby Edition" official Nintendo software.
----------------------------------------------------------------

Contact: dudaw.contact@gmail.com
 2011 http://dudaw.webs.com
